home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / program / catgen20.zip / CATGEN.DOC < prev    next >
Text File  |  1996-07-08  |  10KB  |  240 lines
  1.                                CatGen v2.0
  2.                         (C) 1996 Inventive Software
  3.                            Mark Glenn, President
  4.                          -------------------------
  5.  
  6.     INTRODUCTION
  7.     ------------
  8.  
  9.     CatGen v2.0 is a program to allow programmers of QB or QBASIC to have a
  10.     useful file to BAS converter.
  11.  
  12.     Only compiling is required to create these catalogs.
  13.  
  14.     REQUIREMENTS
  15.     ------------
  16.       1) Color Monitor
  17.       2) QB or QBasic
  18.       3) Hard drive
  19.       4) QB for compilation
  20.       5) Keyboard
  21.  
  22.     FEATURES included
  23.     -----------------
  24.       1) Color capability
  25.       2) Speed (YEAH SPEEEEEED)
  26.       3) 5000 line maximum
  27.       4) Scrolling feature
  28.       5) Convert TEXT to BAS to be compiled
  29.       6) Search Feature (New in release 1.2)
  30.       7) Multi colored lines
  31.       8) Background colors
  32.       9) No flickering
  33.      10) One file only (Doc inside BAS file)
  34.  
  35.     TABLE OF CONTENTS
  36.     -----------------
  37.       1) What is CatGen v2.0
  38.       2) What is included
  39.       3) Command line perimeters
  40.       4) What is it doing while running.
  41.       5) How does it do all this
  42.       6) I've run it, now what?
  43.       7) Color
  44.       8) Modifying
  45.       9) How do I use the actual compiled work.
  46.      10) Final touches
  47.      
  48.     APPENDIXES
  49.     ----------
  50.       A) Trouble Shooting
  51.       B) Upcoming Features
  52.       C) Features of each version.
  53.       D) Information about our company
  54.       E) Other programs
  55.  
  56.   1) What is CatGen v2.0?
  57.      ---------------------
  58.      CatGen v2.0 is a program that takes your TEXT files and converts them
  59.   into self running file viewers.  Not only that, but it is in color. 
  60.   Believe it or not, this file was created with CatGen v1.4.  It's
  61.   capabilities are outrages.  It has absolutely no flicker and has incredible
  62.   speed.  It is based on 25x80 screen size and will look quite weird in 50x80.
  63.   It has scrolling features that will be used by using the up, down, PGUP, PGDN
  64.   keys.  The best feature though is that you can distribute your file.
  65.  
  66.      Okay, from v1.4 and on, there is a new feature.(WOW)  It makes Online
  67.   help files.  Cool.
  68.  
  69.     2) What is included?
  70.      -----------------
  71.      CatGen comes with 9 files
  72.       1: CATGEN.EXE  - The catalog generator
  73.       2: CATDOC.BAS  - This file source code
  74.       3: CATDOC.EXE  - This file
  75.       4: CATGEN.DOC  - This file in TEXT format
  76.       5: ORDER.FRM   - Order and Registration file for other programs
  77.       6: FILE_ID.DIZ - File Info
  78.       7: CATALOG.EXE - Catalog for Inventive Software
  79.  
  80.   3) Command line perimeters
  81.      -----------------------
  82.      There really is only one command line perimeter.
  83.        : CatGen Infile.ext (Outfile.ext)
  84.         The Infile.exe must be include.  Outfile.ext is something that is
  85.         optional.  If you decide not to use this, it will output to CAT1.OUT.
  86.  
  87.   4) What is it doing while running?
  88.      -------------------------------
  89.      It does multiple things.  It first creates a temp file called TEMP1.TMP
  90.   that holds your DOC with the DATA statements in front of it.  Then it goes
  91.   in and loads all the BASIC statements to run it.  A file is created called
  92.   (filename) and you have a finished product ready to compile.
  93.  
  94.   5) How does it do all this?
  95.      ------------------------
  96.      It takes your file and process it and creates BASIC text.  Take a look at
  97.   the file sometime and see how it is really done.
  98.  
  99.   6) I've run it, now what?
  100.      ----------------------
  101.      Okay, you have created your file and now it is time to modify.  Look at
  102.   Chapter 8 for that.  Chapter 7 shows how to change the color of each line.
  103.   After that, you want to compile it.  Load the program into QB by typing this:
  104.     QB filename
  105.   Now go to run and compile.  Make it Stand Alone EXE and click on Make EXE
  106.   and Exit.
  107.  
  108.   7) Color
  109.      -----
  110.      Wow, I can change color?  Yep, you can.  If you look at the end, you will
  111.   see that is says the DATA statement and then the numbers '03'.  This is the
  112.   color that it changes it all to.  You can change this number to anything.
  113.   It must be two digits long like:  03 or C5.  In 2.0, the numbers were
  114.   changed to hex so you can now do backgrounds.  The colors are as following:
  115.   00) BLACK       08) GREY             10) BLACK ON BLUE
  116.   01) BLUE        09) LIGHT BLUE       FF) BRIGHT WHITE ON WHITE
  117.   02) GREEN       0A) LIGHT GREEN
  118.   03) CYAN        0B) LIGHT CYAN
  119.   04) RED         0C) LIGHT RED
  120.   05) MAGENTA     0D) LIGHT MAGENTA
  121.   06) BROWN       0E) YELLOW
  122.   07) WHITE       0F) BRIGHT WHITE
  123.  
  124.   8) Modifying
  125.      ---------
  126.      For people who want to make a big logo on the doc, I included a ANSI to
  127.   CATGEN converter.  All you do is add it to your doc and it will look exactly
  128.   like the ansi file.  (Sorry, no animations and only 25 lines long).
  129.  
  130.   9) How do I use the actual compiled work?
  131.      --------------------------------------
  132.      Well, you first run the program.  You see the file and information at the
  133.   bottom.  You use the arrow keys or the PGUP or PGDN key.  These move the DOC
  134.   up or down.  The new feature is the "S" feature.  It searches the file for
  135.   whatever you want.
  136.  
  137.  10) Final Touches
  138.      -------------
  139.      Since I don't really know any final touches, but all great DOCs have this
  140.    area.  You can modify the generated file all you want.  The generated viewer
  141.    is freeware and maybe modified and distributed without permission.  Think of
  142.    it as your program you and only you made.
  143.  
  144.   A) Trouble Shooting
  145.      ----------------
  146.      1) While compiling, it says an out of memory error
  147.        A:Try freeing more memory.  If you don't want to do this, if you look
  148.           at the begining of the file, it shows DIM statements.  Change this
  149.           to the length of your file.  If you don't know the length, look at
  150.           the first DATA statement.  It will say something like this:
  151.            DATA 253
  152.           Change the DIM statements to:
  153.            DIM text$(255) 'add 2 just in case
  154.            DIM ColorVal(255) 'add 2 just in case
  155.            You shouln't have to do this because it is automatic now.
  156.      2) While compiling, it says an error
  157.        A:Try trouble shooting it.  If that doesn't work, re-generate the file.
  158.           if that still doesn't work, contact me about it.
  159.      3) Doesn't generate
  160.        A:You have a corrupted CatGen v2.0.  Please reinstall.  You may also
  161.           have a bad output file.  DOS only allows certain characters in
  162.           filenames.  Try a filename with only letters:
  163.            CATGEN MY.DOC MYDOC.BAS
  164.      4) Bombs
  165.        A:You have a corrupted CatGen v2.0.  Please reinstall.
  166.      5) Subscript out of range
  167.        A:Your file is more than your memory can handle.  Cut it down.
  168.      6) Unexpected error, please recompile
  169.        A:For some odd reason, your DOC got edited so it can not be used.  You
  170.          might have edited it and messed it up.  If you know what you are
  171.          doing, take out the ON ERROR statement and try to debug it.  If not,
  172.          re compile it.  If the same error occurs, contact me.
  173.      7) I lost my cursor.
  174.        A:When the Help is invoked, it turns off the cursor.  It doesn't just
  175.          disappear.  Just turn it back on:
  176.          LOCATE , , 1, 7, 8
  177.      8) 
  178.  
  179.   B) Upcoming Features
  180.      -----------------
  181.        Use EMS or XMS
  182.        ANSI file support  -+___ Coming in
  183.        Ending screen      -+       v2.1
  184.  
  185.   C) Features of Each Version
  186.      ------------------------
  187.       v1.0b - The first official version.  Never distributed.
  188.  
  189.       v1.0 - Added color feature.  PGUP and PGDN keys added.  Fixed
  190.              Arrow key bug.  Finally distributed
  191.  
  192.       v1.1 - Search feature added.  Also added the ON ERROR function so
  193.              (Just in case) if it has an error it won't show that ugly error
  194.              screen.  Added the registration file(oops, sorry to everyone
  195.              with version 1.0).
  196.  
  197.       v1.2 - Added 'S' at the bottom.  Fixed the scrolling up one line on
  198.              search bug.  Fixed bottom text on no search bug.  Man